home *** CD-ROM | disk | FTP | other *** search
/ The X-Philes (2nd Revision) / The X-Philes Number 1 (1995).iso / xphiles / hp95 / freyja13.exe / lha / README < prev    next >
Text File  |  1992-03-22  |  11KB  |  376 lines
  1.               Freyja Text Editor Overview
  2.            (Freyja Reduksjon Emacs, Ytre Jevn All)
  3.          (Freyja Reduces Emacs Yet Joins All)
  4. Version 1.3     Copyright 1991,2 by Craig A. Finseth        21 March 1992
  5.  
  6. Sections:
  7.  
  8.     What It Is
  9.     Status
  10.     Version History
  11.     How To Obtain a Copy
  12.     How To Obtain Support
  13.     Supported Environments
  14.     Installation
  15.     File-by-File
  16.  
  17. -----------------------------------------------------------------
  18. What It Is
  19.  
  20. Freyja is an Emacs-type text editor that implements my choice of Emacs
  21. commands.  It also includes an RPN-calculator and perpetual calendar. 
  22. It is extensible by changing the source code and recompiling.  While it
  23. runs on UNIX systems, it is targeted to MS/DOS laptop and palmtop
  24. machines.
  25.  
  26. As a text editor, Freyja includes the following features:
  27.  
  28.     - full range of character, line, word, sentence, and
  29.     paragraph-oriented commands.
  30.     - search, replace, and query replace
  31.     - deletions are automatically saved into a "kill buffer"
  32.     - ability to edit up to 11 files at once
  33.     - ability to view two windows at once
  34.     - integrated help facility
  35.     - commands to change the case of text, change indentation,
  36.     and perform many other functions
  37.     - can record and play back keyboard macros
  38.     - includes a perpetual calendar
  39.     - includes a fully-integrated HP-45A type calculator
  40.     - configurable with a FREYJA.INI file
  41.     - system-manager compliant version for the HP95LX
  42.  
  43. -----------------------------------------------------------------
  44. Status:
  45.  
  46. With the exception of two files, the entire release is freeware
  47. distributed under the same terms as GNU CopyLeft.
  48.  
  49. The two files are c0s.asm and makeexm.c.  These files are placed
  50. wholly in the public domain and anyone, anywhere can use them for any
  51. purpose in any way.  It is silly to make others have to reinvent this
  52. particular wheel.  Please use them with my blessings.
  53.  
  54. There is still a pesky bug in the MS/DOS version.  (It does not appear
  55. to be present in the Unix or HP95LX system-manager compliant
  56. versions.)  If you edit a lot -- especially interrupting redisplay --
  57. and exit, it (randomly) hangs at the call to _exit.  Of course, I
  58. can't make it happen whenever I try to find and fix it...
  59.  
  60. -----------------------------------------------------------------
  61. Version History:
  62.  
  63. 1.1     3 Aug 1991    first release
  64. 1.2    15 Aug 1991    second release: minor bug fixes in ^C, ^[ ^E,
  65.             Ins, Enter (in calculator) and redisplay;
  66.             added keyboard switch
  67. 1.3    21 Mar 1992    third release: reworked .ini file reading, fixed
  68.             minor bugs; ^X ^D now includes hidden files; file
  69.             I/O can now be unprocessed; all columns of the
  70.             screen are now used; ^U ^W doesn't save deleted
  71.             text; removed the date/time stamp command and
  72.             date time format support; created system-manager
  73.             compliant versions
  74.  
  75. -----------------------------------------------------------------
  76. How To Obtain a Copy:
  77.  
  78. Diskette: Send the author blank diskettes:
  79.  
  80.     - two, 5 1/4" (360 KB) or
  81.     - one, 3 1/2" (either 720 KB or 1.44 MB)
  82.  
  83. and enough stamps to cover return postage plus a dollar or so (so that
  84. I can buy a diskette mailer).  Or you can just send me about US$3.00
  85. in check, stamp, whatever and I will furnish the diskette(s) and
  86. mailer.
  87.  
  88. Anonymous FTP:
  89.     mail.unet.umn.edu in import/freya.tar or import/freya.tar.Z
  90.     irisia.irisia.fr in /HP95LX/editors/freyja.tar.Z
  91.  
  92. -----------------------------------------------------------------
  93. How To Obtain Support:
  94.  
  95.     not supported, author is:
  96.  
  97.     Craig Finseth
  98.     1343 Lafond
  99.     St Paul MN 55104
  100.     USA
  101.  
  102.     +1 612 644 4027
  103.  
  104.     fin@unet.umn.edu
  105.     Craig.Finseth@nic.mr.net
  106.  
  107. -----------------------------------------------------------------
  108. Supported Environments:
  109.  
  110.     Tested on SunOs 4.0.3.
  111.     Should run under most Berkeley Unix environments.
  112.  
  113.     Tested on MS/DOS V3.x and should run on any MS/DOS version 2.0
  114.     or later system.  Requires Borland Turbo C Version 2.0 or
  115.     later to compile (it should compile and run under Microsoft C
  116.     with only minor changes).
  117.  
  118.     Tested on HP95LX.
  119.  
  120. -----------------------------------------------------------------
  121. Installation #1 (from diskette, for MS/DOS):
  122.  
  123. 1) Make a directory on the MSDOS system:
  124.  
  125.     cd <whereever>
  126.     mkdir freyja
  127.     cd freyja
  128.  
  129. 2) Copy the freyja files from the diskette(s) to this directory.
  130.  
  131.     copy a:*.*
  132.  
  133. 3) If you just want to run the regular versions, stop here.
  134.  
  135. If you want to make a new version:
  136.  
  137. 4) In fgenlib.h, make sure that the correct system constant is #defined.
  138.  
  139. 5) Edit turboc.cfg to suit your system.
  140.  
  141. 6) Make it:
  142.  
  143.     copy makefile.msd makefile
  144.     <edit makefile to select the regular or system-manager compliant
  145.         version>
  146.     make
  147.  
  148. -----------------------------------------------------------------
  149. Installation #2 (from .tar files, for MS/DOS):
  150.  
  151. 1) Copy the freyja files to a freyja directory.
  152.  
  153. 2) Follow the steps in installation #1 starting with step 3.
  154.  
  155. -----------------------------------------------------------------
  156. Installation #3 (from diskette or .tar files, for HP95LX):
  157.  
  158. 1) Obtain an IBM PC version.  Note that the FREYJA.EXE and  FREYJA.EXM
  159. files are included with the distribution, so that you don't have to
  160. compile anything if you just want to run the off-the-shelf versions.
  161.  
  162. 2) Set up a FREYJA.INI file.  You can either create it on a PC and
  163. download or use the MEMO application.  Mine looks like this:
  164.  
  165.     swa 40
  166.     spe j
  167.     pa1 p    (optional, turns off serial port power while
  168.         in Freyja, then on upon exiting)
  169.     met i    (optional)
  170.     use n    (optional)
  171.     wra y    (optional)
  172.  
  173. See the distribution FREYJA.INI file for explanations of these
  174. options.  The same file can be used for both the versions: the
  175. system-manager compliant version ignores any parameters that don't
  176. apply.
  177.  
  178. I put this file in the C:\_DAT directory.
  179.  
  180. 3) If you want to use the system-manager compliant version:
  181.  
  182.     3A) Load FREYJA.EXM into the HP95LX.
  183.  
  184.     3B) The minimum system RAM required is 218K.  This number
  185.     assumes a 40K swap area, and no other applications open or
  186.     other uses of memory.
  187.  
  188.     3C) Create or add to your C:\_DAT\APNAME.LST file.  Here is
  189.     an example entry that uses the Alt-MEMO key:
  190.  
  191.         c:\_dat\freyja.exm,bb00,Freyja^M
  192.  
  193.     Or, if you are like me:
  194.  
  195.         c:\_dat\freyja.exm,b800,Freyja^M
  196.  
  197.     And thus override the built-in MEMO function.
  198.  
  199.     The first field if the full pathname of the .EXM file.  The
  200.     second field is the scan code of the hot key.  The third
  201.     field is the name.  The whole thing is terminated by a Carriage
  202.     Return.
  203.  
  204.     key        base    w/Ctrl    w/Alt
  205.  
  206.     FILER        a800    ae00    ab00
  207.     COMM        ac00    b200    af00
  208.     APPT        b000    b600    b300
  209.     PHONE        b400    ba00    b700
  210.     MEMO        b800    be00    bb00
  211.     123        bc00    c200    bf00
  212.     CALC        c000    c600    c300
  213.  
  214.     Don't forget to reboot the HP95LX.
  215.  
  216. 4) If you want to use the regular version:
  217.  
  218.     4A) Load FREYJA.EXE into the HP95LX.
  219.  
  220.     4B) The minimum system RAM required is 282K.  This number
  221.     assumes a 40K swap area, and no other applications open or
  222.     other uses of memory.
  223.  
  224.     4C) Instead of setting the swap area size in FREYJA.INI,
  225.     you could run a DOS shell (MENU S in the FILER) and  give
  226.     this command line:
  227.  
  228.         freyja -z 40
  229.  
  230.     But this is more work as you have to do it each time.
  231.  
  232.     4D) A typical configuration is to put FREYJA.EXE in C:\ and
  233.     FREYJA.INI in C:\_DAT.  To make this work, do:
  234.  
  235.     create or add to CONFIG.SYS:
  236.  
  237.         shell=command /p
  238.  
  239.     create or add to AUTOEXEC.BAT:
  240.  
  241.         set FREYJADIR=C:\_DAT
  242.         $SYSMGR
  243.  
  244.     Then reboot.
  245.  
  246. -----------------------------------------------------------------
  247. Installation #4 (from .tar files, for UNIX):
  248.  
  249. 1) In fgenlib.H, make sure that the correct system constant is #defined.
  250.  
  251. 2) Configure the editor (look at the beginning of freyja.h).
  252.  
  253. 3) Make it:
  254.  
  255.     mv Makefile.unx Makefile
  256.     make
  257.  
  258. 4) Install it, do:
  259.  
  260.     cp freyja <your binary directory, /usr/local/bin?> 
  261.  
  262. 5) Install the documentation files (there is no man page) Consult
  263. freyja.doc for search path information:
  264.  
  265.     cp f*.doc    <somewhere in the search path>
  266.  
  267. 6) If desired, change freyja.ini, then put this default version
  268. somewhere in the search path.
  269.  
  270. -----------------------------------------------------------------
  271. Installation #5 (from diskette, for UNIX):
  272.  
  273. 1) Make a directory on the UNIX system:
  274.  
  275.     cd <whereever>
  276.     mkdir freyja
  277.     cd freyja
  278.  
  279. 2) Copy the freyja files from the diskette(s) to this directory.
  280.  
  281.     copy a:*.*
  282.  
  283. 3) Follow the steps in installation #4 starting with step 1.
  284.  
  285. -----------------------------------------------------------------
  286. File-by-File:
  287.  
  288. makefile.msd    MS/DOS Makefile
  289. Makefile.unx    UNIX Makefile
  290.  
  291. README        this file
  292.  
  293. ascii        ASCII chart
  294.  
  295. buf.c        buffer management routines
  296.  
  297. c0s.asm        replacement startup code for use with the system-manager
  298.         compliant version
  299.  
  300. calc.c        calculator routines
  301.  
  302. char.c        character-, line-, and screen-oriented commands
  303.  
  304. date.c        date arithmetic routines
  305.  
  306. display.c    display and display output routines
  307.  
  308. emacs        a listing of emacs implementations
  309.  
  310. fcalc.doc    calculator documentation
  311. fcmdlist.doc    command list
  312. fcmdxref.doc    command cross reference
  313. fcopying.doc    copying information
  314. ffsf.doc    Free Software Foundation information
  315.  
  316. fgenlib.h     General library header file.
  317.  
  318. file.c        file-, buffer-, and system-oriented commands
  319.  
  320. fleague.doc    League for Programmer Freedom information
  321.  
  322. flib.c        General library routines
  323.  
  324. freyja.c    top level
  325.  
  326. freyja.doc    documentation, such as it is
  327.  
  328. freyja.exe    MS/DOS executable, regular
  329. freyja.exm    MS/DOS executable, system-manager compliant
  330.  
  331. freyja.h    main include file
  332.  
  333. freyja.ini    template for .ini file
  334.  
  335. freyja.lnk    MS/DOS linker directive file
  336.  
  337. ftutoria.doc    introductory tutorial
  338.  
  339. fwarrant.doc    warranty information
  340.  
  341. help.c        help stuff
  342.  
  343. ini.c        load the initialization file
  344.  
  345. jaguar.c    HP95LX (Jaguar) interface routines
  346.  
  347. key.c        keyboard and input routines
  348.  
  349. libasm.asm    MS/DOS assembly language interface routines
  350.  
  351. makeexm.c    MS/DOS source to the makeexm program, which builds a .EXM file
  352.  
  353. misc.c        miscellaneous commands
  354.  
  355. region.c    region-oriented commands
  356.  
  357. smfreyja.lnk    MS/DOS linker directive file for the system-manager compliant
  358.         version
  359.  
  360. smjaguar.c    HP95LX (Jaguar) interface routines for the system-manager
  361.         compliant version
  362.  
  363. table.c        command table routines
  364.  
  365. term.c        terminal interface routines
  366.  
  367. turboc.cfg    MS/DOS Turbo C configuration file
  368.  
  369. white.c        whitespace-oriented commands
  370.  
  371. word.c        word-oriented commands (including sentence, number,
  372.         and paragraph)
  373.  
  374. xprintf.c    replacement/supplement for printf
  375. xprintf.doc
  376.